CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/resources:read (Post)
In This Topic
    Post/projects/{projectId}/resources:read
    In This Topic
    Description
    Gets an array of resource objects that satisfy the filter criteria specified in the request body.
    Parameters
    NameDescriptionData Type
    projectIdthe id of the projectstring
    Request (application/json)

    The request body is of type object.

    Overview

    Filters : ResourceFilters
    ResourceID : string
    provides a wild card string to filter resources by their ResourceID.
    Description : string
    provides a wild card string to filter resources by their Description.
    limit : integer
    skip : integer
    200 Response

    The response body is of type ResourcesGetResponse.

    The collection of resources that satisfy the query.

    Overview

    ResourcesGetResponse
    The results of the resources get query.
    Resources : Array[CimResource]
    An array of the resources that satify the query criteria.
    ResourceID : string
    The Id of resource.
    Description : string
    The desciption of the resource.
    EnableAlarmCounters : boolean
    set it to true to enable alarm counters for this resource.
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    Remarks
    Returns JSON containing an array of CIMPLICITY resource objects
    See Also
    All Operations Resource Group | CIMPLICITY REST API Web Service

     

     

    © 2021 All Rights Reserved.